import logging
import logging.handlers
import os

from flask import request


class RequestShoppingFormatter(logging.Formatter):
    '''
    自定义日志输出格式，要继承logging.Formatter,重写format方法
    '''

    def format(self, record):
        record.url = request.url  # 获取请求的路径，并添加到record中（添加到record是我猜测的）
        record.remote_addr = request.remote_addr  # 获取远程客户端地址，并添加到record中
        return super().format(record)  # 返回 父类中的format函数的执行结果， super().format(record)是调用父类的format函数


# 创建一个个性化的logger（日志器） 对象
def create_logger(app):
    '''
    设置日志配置
    :param app: Flask中的app对象
    :return:
    '''
    logging_file_dir = app.config['LOGGING_FILE_DIR']
    logging_file_max_bytes = app.config['LOGGING_FILE_MAX_BYTES']
    logging_file_backup = app.config['LOGGING_FILE_BACKUP']
    logging_level = app.config['LOGGING_FILE_LEVEL']

    # 设置日志的输出格式布局（针对文件）
    request_formatter = RequestShoppingFormatter(
        '[%(asctime)s] %(remote_addr)s 请求 %(url)s  \t %(levelname)s 在 %(module)s %(lineno)d : %(message)s')
    # 传入的这个字符串格式中，remote_addr 和 url 是自己在上面自定义格式时存入的，其余的都是Format中自带的LogRecord属性。其中message是真正的日志信息

    # 检查存放日志的目录是否存在，如果不存在就需要创建
    if os.path.exists(logging_file_dir):  # 这个判断目录是否存在，是判断同级中是否存在这个目录,或者说是当前路径下是否有这个目录
        pass  # 如果存在就pass
    else:
        os.mkdir(logging_file_dir)  # 在当前路径下创建目录。创建的目录是在主应用程序shopping下面，是因为这个函数是在shopping下的init文件中运行的，
                                    #而os.mkdir()创建目录时是在函数运行的当前路径下创建目录的，init所在的目录就是shopping,所以会在shopping
                                    #下面创建logs这个目录。
        # print(os.path.join(os.path.dirname(__file__)))打印出的是这个函数所在的文件所在的目录。

    # 创建一个Handler,指定日志存放的目录和文件(属性、个数)。
    flask_file_handler = logging.handlers.RotatingFileHandler(filename=os.path.join(logging_file_dir, 'shopping.log'),
                                                              maxBytes=logging_file_max_bytes,
                                                              backupCount=logging_file_backup)

    # 给当前handler设置格式
    flask_file_handler.setFormatter(request_formatter)
    # 创建一个logger对象
    flask_logger = logging.getLogger('shopping')  # 这里的日志记录器的名字不能乱写。只有主应用程序的名称和日志记录器的名称相同时，日志消息才会输入到主应用程序下面的的日志文件中。
                                                #总之，这里涉及路径问题，如果不写的和主应用程序的名字一样，就需要解决的路径问题。
    flask_logger.addHandler(flask_file_handler)  # 将flask_file_handler 添加到日志器logger中
    flask_logger.setLevel(logging_level)  # 设置日志器的日志等级，当然handler中也可以再次设置日志级别（好像是这样的）

    # **************************一个logger下面可以有多个handler*******************************

    # 整个项目需要两个handler,文件、控制台
    # 上面的handler是向文件中存放日志信息的。下面再创建一个handler向控制台输出日志信息

    flask_console_handler = logging.StreamHandler()  # StreamHandler是一个默认的handler,就是向控制台输出日志信息的
    flask_console_handler.setFormatter(
        logging.Formatter('[%(asctime)s] %(levelname)s 在 %(module)s %(lineno)d : %(message)s'))

    # 判断服务器是否是debug模式，决定要不要向控制台输出日志信息()是否将flask_console_handler添加到logger中
    if app.debug:
        flask_logger.addHandler(flask_console_handler)
